brShop24 API
Bei der brShop24 API handelt es sich um eine Schnittselle zum BÜRORING eg Shop-System, mit welcher strukturierte Daten mit anderen Anwendungen ausgetauscht werden können.
Möchten Sie z.B. Shop-Informationen wie Artikel Daten, Bestellungen und Benutzer an Ihr Warenwirtschaftssystem übertragen, können diese mit Hilfe der API in Form von Anfragen (Querys) abgerufen und exportiert werden.
Für den Import von Daten aus Fremdsystemen in das Shop-System stehen Mutationen (Mutations) zur Verfügung, welche es Ihnen ermöglichen neue Daten im Shop-System anzulegen, zu ändern und zu löschen.
{warning} Die brshop24 API hat den Status "Work in progress". Bei dieser Dokumentation handelt sich um einen Vorabzug zu Testzwecken.
Informationen rund um den brShop24 Entwicklungsstatus finden Sie in unserem Entwickler Blog
GraphQL Grundlage
Die Umsetzung der brShop24 API basiert auf GraphQL.
GraphQL ist eine Abfragesprache für Webapplikationen, welche von Facebook entwickelt und unter Open Source Lizenz veröffentlicht wurde.
Die Abfragesprache standisiert die Form der des Datenaustausches. Die Applikations- und Businesslogik wird von uns in Bezug auf die Anforderungen implementiert.
Die wesentlichen Vorteile von GraphQL sind:
- Standadisierte Datenübermittlung
- Hohe Verbreitung = gemeinsame Basis (Nutzer von GraphQL)
- Die Abfrage bestimmt das Ergebnis - so bekommt man das was man benötigt - nicht mehr und nicht weniger. Dies reduziert den Overhead an Daten den wir aus vielen anderen Formen von APIs kennen.
- Keine Versionierung der API mehr notwendig - die API wächst mit den Anforderungen dies bedeutet weniger Entwicklungsaufwand und neue Funktionen können nathlos zur Verfügung gestellt werden.
- Alle API Anfragen werden über EINEN zentralen Endpunkt gesteuert
- GraphQL ist selbstdokumentierend
Mittlerweile wurde GraphQL in ein breites Spektrum von Programmiersprachen und Frameworks implemetiert und kann somit in vielen Softwareprojekten genutz werden.
Dies ermöglicht eine einfache Integration der brShop24 API.
Eine aktuelle Liste der Programmiersprachen & Frameworks finde sie hier.
Hinweis für VShop PRO Nutzer
Wenn Sie bisher den VShop PRO einsetzen und Anbindungen an Ihre interne Software entwickelt haben, sollte vor dem Umstieg auf den brShop24 folgendes berücksichtigt werden:
Alle Import & Export Prozesse zu Fremdsystemen werden im brShop24 ausschließlich über die API abgewickelt. Direkte Datenbankzugriffe sind nicht (mehr) gestattet.
Die Vorteile:
- Mit diesem Schritt sorgen wir für mehr Sicherheit und einen kontrollierten Datenaustausch.
- Die Datenintegrität Ihres Shop-Systems wird gewährleistet
- Der Zugriff von API Nutzern kann "verrechtet" werden. So können Sie z.B. Applikation A erlauben Preise und Artikel zu importieren, während Applikation B z.B. nur Artikelinformationen abrufen darf.
- Der Datenaustausch wird standadisiert und mit modernen, etablierten und verbreiteten Werkzeugen umgesetzt. Standards bedeuten für Sie "Das Rad muss nicht jedesmal neu erfunden werden!". Dies spart Zeit, Aufwand und Geld in der Umsetzung von Schnittstellen.
Der Nachteil:
Ihr individuell entwickelten Schnittstellen zu Ihren hausinternen Systemen müssen bei Umstieg auf den brShop24 an die API angepasst werden.
Als Entwickler wissen wir: dies kostet Zeit und muss in Ihre Terminplanung passen.
Aus diesem Grund ermöglichen wir Ihnen einen "weichen Umstieg" unter folgenden Gesichtspunkten:
- Es wird keinen "Zwangsumstieg" von VShop PRO auf brShop24 geben
- Der VShop PRO und der brShop24 werden langfristig (2-3 Jahre) parallel betrieben und supported
- Wir "öffnen" die API zu einem frühen Zeitpunkt - vor Freigabe, um Ihnen die Möglichkeit für Tests zu bieten.
Das schafft Ihnen die Möglichkeit, Ihren Umstieg langfristig zu planen und zu testen.
Fragen, Anregungen & Fehlermeldungen
Sie haben Fragen zur brShop24 API?
Schreiben Sie uns eine E-Mail an support@bueroring.de.
Wir freuen uns über Ihr Feedback!